<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Cascading Parameter Group Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">CascadingParameterGroup Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Visual grouping of report cascading parameters.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Cascading Parameter Group</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>XML Element:</td>
<td><code>cascading-parameter-group</code></td></tr>
<tr><td>Extends:</td>
<td><a href="ParameterGroup.html">ParameterGroup</a></td></tr>
<tr><td>Extendable:</td>
<td>Yes</td></tr>
<tr><td>Abstract:</td>
<td>No</td></tr>
<tr><td>Name Space:</td>
<td>Parameters</td></tr>
<tr><td>Name Requirement:</td>
<td>Required</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>No</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-dataSet">dataSet</a></dt>
<dd>The name of the data set that provides data for the dynamic parameters within the group.</dd>
<dt><a href="#Property-dataSetMode">dataSetMode</a></dt>
<dd></dd>
</dl>

<h3>Slot Summary</h3>

<dl class="section-text">
<dt><a href="#Slot-parameters">parameters</a></dt>
<dd>The set of parameters that appear inside the cascading parameter group.</dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="ReportElement.html#Property-comments">comments</a>, 
<a href="DesignElement.html#Property-customXml">customXml</a>, 
<a href="ReportElement.html#Property-displayName">displayName</a>, 
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>, 
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ReportElement.html#Property-extends">extends</a>, 
<a href="ParameterGroup.html#Property-helpText">helpText</a>, 
<a href="ParameterGroup.html#Property-helpTextID">helpTextID</a>, 
<a href="ReportElement.html#Property-name">name</a>, 
<a href="ReportElement.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="ParameterGroup.html#Property-promptText">promptText</a>, 
<a href="ParameterGroup.html#Property-promptTextID">promptTextID</a>, 
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, 
<a href="ParameterGroup.html#Property-startExpanded">startExpanded</a>, 
<a href="DesignElement.html#Property-userProperties">userProperties</a>, 
<a href="ReportElement.html#Property-viewAction">viewAction</a>
</p>
<h3>Description</h3>

<div class="section-text">
<p>A parameter group creates a visual grouping of dynamic 
parameters, value of a paticular parameter depends on the 
value of some other value.  These parameters within 
the group are called cascading parameters. 
<p>The developer controls the order that parameters appear in the group. 
The values of of the cascading parameters will be displayed as dynamically populated 
lists, and they will be displayed in the same order in which they are 
defined in the group. </p>

<p>The parameters in the cascading parameter group
share a same data set.</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-dataSet">dataSet Property</a></h2>

<p class="section-text">The name of the data set that provides data for the dynamic parameters within the group.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../elements/DataSet.html">DataSet</a> Reference</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Data set</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The name of the data set that provides data for the dynamic parameters within the group. 
Parameters in a cascading parameter group share a same data set.</p></div>

<hr>
<h2><a name="Property-dataSetMode">dataSetMode Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (dataSetMode)</td></tr>
<tr><td>Since:</td>
<td>2.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Single or multiple data sets</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>single</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>single</td>
<td>Single data set</td>
<td>single</td>
<td></td></tr>
<tr><td>multiple</td>
<td>Multiple data set</td>
<td>multiple</td>
<td></td></tr>
</tbody></table><br>
<h1>Slot Detail</h1>

<h2><a name="Slot-parameters">parameters Slot</a></h2>

<p class="section-text">The set of parameters that appear inside the cascading parameter group.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Parameters</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>XML Element:</td>
<td><code>parameters</code></td></tr>
<tr><td>Contents:</td>
<td>List of <a href="ScalarParameter.html">ScalarParameter</a></td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The set of parameters that appear inside the cascading parameter group. Each 
parameter is a "dynamic" type, the available values of the parameter is data-driven.
UI should ignore an empty group. Parameters appear in the UI in the same 
order that they are defined in the group.</p></div>
</body>
</html>
